<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>audio_formatter: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">audio_formatter
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__audio__formatter.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter___config.html">XAudioFormatter_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for a audio formatter core.  <a href="struct_x_audio_formatter___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The audio formatter driver instance data structure.  <a href="struct_x_audio_formatter.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_audio_formatter_hw_params.html">XAudioFormatterHwParams</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains hw params information for a audio formatter core.  <a href="struct_x_audio_formatter_hw_params.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga73a0740e9df67c58f6ffa8dc6c40f26a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga73a0740e9df67c58f6ffa8dc6c40f26a">XAUDFMT_H_</a></td></tr>
<tr class="memdesc:ga73a0740e9df67c58f6ffa8dc6c40f26a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#ga73a0740e9df67c58f6ffa8dc6c40f26a">More...</a><br/></td></tr>
<tr class="separator:ga73a0740e9df67c58f6ffa8dc6c40f26a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga53384ac363365da9f8e31ed55cbf1d0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga53384ac363365da9f8e31ed55cbf1d0b">XAudioFormatterDMAReset</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga53384ac363365da9f8e31ed55cbf1d0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function soft resets the audio formatter DMA core.  <a href="#ga53384ac363365da9f8e31ed55cbf1d0b">More...</a><br/></td></tr>
<tr class="separator:ga53384ac363365da9f8e31ed55cbf1d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef1d64562a996ebb195cf2d6ef2f6ea7"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#gaef1d64562a996ebb195cf2d6ef2f6ea7">XAudioFormatter_CfgInitialize</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, <a class="el" href="struct_x_audio_formatter___config.html">XAudioFormatter_Config</a> *CfgPtr)</td></tr>
<tr class="memdesc:gaef1d64562a996ebb195cf2d6ef2f6ea7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the audio formatter core instance.  <a href="#gaef1d64562a996ebb195cf2d6ef2f6ea7">More...</a><br/></td></tr>
<tr class="separator:gaef1d64562a996ebb195cf2d6ef2f6ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6bf13816fa1c5fa913e85ec5734b7dcd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga6bf13816fa1c5fa913e85ec5734b7dcd">XAudioFormatter_InterruptClear</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 mask)</td></tr>
<tr class="memdesc:ga6bf13816fa1c5fa913e85ec5734b7dcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function clears the interrupts for audio formatter core.  <a href="#ga6bf13816fa1c5fa913e85ec5734b7dcd">More...</a><br/></td></tr>
<tr class="separator:ga6bf13816fa1c5fa913e85ec5734b7dcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5779760c06dac849bd2e52ceded0ad65"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga5779760c06dac849bd2e52ceded0ad65">XAudioFormatter_InterruptEnable</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga5779760c06dac849bd2e52ceded0ad65"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables the interrupts for audio formatter core.  <a href="#ga5779760c06dac849bd2e52ceded0ad65">More...</a><br/></td></tr>
<tr class="separator:ga5779760c06dac849bd2e52ceded0ad65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c0f40a1f11f81c15f0bd0e1aea25d0a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga9c0f40a1f11f81c15f0bd0e1aea25d0a">XAudioFormatter_InterruptDisable</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga9c0f40a1f11f81c15f0bd0e1aea25d0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables the interrupts for audio formatter core.  <a href="#ga9c0f40a1f11f81c15f0bd0e1aea25d0a">More...</a><br/></td></tr>
<tr class="separator:ga9c0f40a1f11f81c15f0bd0e1aea25d0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65ddaecacb3d843dade3da4a44862963"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga65ddaecacb3d843dade3da4a44862963">XAudioFormatterDMAStart</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga65ddaecacb3d843dade3da4a44862963"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function starts the dma for audio formatter core.  <a href="#ga65ddaecacb3d843dade3da4a44862963">More...</a><br/></td></tr>
<tr class="separator:ga65ddaecacb3d843dade3da4a44862963"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95f19d9d0e20ad8b8bafcaf277ea1ca3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga95f19d9d0e20ad8b8bafcaf277ea1ca3">XAudioFormatterDMAStop</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga95f19d9d0e20ad8b8bafcaf277ea1ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops the dma for audio formatter core.  <a href="#ga95f19d9d0e20ad8b8bafcaf277ea1ca3">More...</a><br/></td></tr>
<tr class="separator:ga95f19d9d0e20ad8b8bafcaf277ea1ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0d2e42ac1ba8d83eca142032ad59320b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga0d2e42ac1ba8d83eca142032ad59320b">XAudioFormatterSetHwParams</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, <a class="el" href="struct_x_audio_formatter_hw_params.html">XAudioFormatterHwParams</a> *hw_params)</td></tr>
<tr class="memdesc:ga0d2e42ac1ba8d83eca142032ad59320b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the hw params for audio formatter core.  <a href="#ga0d2e42ac1ba8d83eca142032ad59320b">More...</a><br/></td></tr>
<tr class="separator:ga0d2e42ac1ba8d83eca142032ad59320b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc41edf6bcea2a85b50e8893016fb267"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#gabc41edf6bcea2a85b50e8893016fb267">XAudioFormatterGetDMATransferCount</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr)</td></tr>
<tr class="memdesc:gabc41edf6bcea2a85b50e8893016fb267"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the No.  <a href="#gabc41edf6bcea2a85b50e8893016fb267">More...</a><br/></td></tr>
<tr class="separator:gabc41edf6bcea2a85b50e8893016fb267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d1e04ada72ed2b53ee4c03809f8146e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga6d1e04ada72ed2b53ee4c03809f8146e">XAudioFormatterSetS2MMTimeOut</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 TimeOut)</td></tr>
<tr class="memdesc:ga6d1e04ada72ed2b53ee4c03809f8146e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the S2MM timeout.  <a href="#ga6d1e04ada72ed2b53ee4c03809f8146e">More...</a><br/></td></tr>
<tr class="separator:ga6d1e04ada72ed2b53ee4c03809f8146e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4e206855fe0fd0b43a40050d494b40f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#gae4e206855fe0fd0b43a40050d494b40f">XAudioFormatterSetFsMultiplier</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u32 Mclk, u32 Fs)</td></tr>
<tr class="memdesc:gae4e206855fe0fd0b43a40050d494b40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calculates the Fs multiplier value.  <a href="#gae4e206855fe0fd0b43a40050d494b40f">More...</a><br/></td></tr>
<tr class="separator:gae4e206855fe0fd0b43a40050d494b40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabec553226fe4cfd97f01d23b2c30bbad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#gabec553226fe4cfd97f01d23b2c30bbad">XSdiAud_GetChStat</a> (<a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *InstancePtr, u8 *ChStatBuf)</td></tr>
<tr class="memdesc:gabec553226fe4cfd97f01d23b2c30bbad"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads all the Channel Status registers and writes to a buffer.  <a href="#gabec553226fe4cfd97f01d23b2c30bbad">More...</a><br/></td></tr>
<tr class="separator:gabec553226fe4cfd97f01d23b2c30bbad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga306c87bbfa3dfceed94dec4591465bf5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_audio_formatter___config.html">XAudioFormatter_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__formatter.html#ga306c87bbfa3dfceed94dec4591465bf5">XAudioFormatter_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:ga306c87bbfa3dfceed94dec4591465bf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">XAudioFormatter_LookupConfig returns a reference to an <a class="el" href="struct_x_audio_formatter___config.html" title="This typedef contains configuration information for a audio formatter core. ">XAudioFormatter_Config</a> structure based on the unique device id, <em>DeviceId</em>.  <a href="#ga306c87bbfa3dfceed94dec4591465bf5">More...</a><br/></td></tr>
<tr class="separator:ga306c87bbfa3dfceed94dec4591465bf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga73a0740e9df67c58f6ffa8dc6c40f26a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XAUDFMT_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaef1d64562a996ebb195cf2d6ef2f6ea7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAudioFormatter_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter___config.html">XAudioFormatter_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the audio formatter core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance. </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>is a reference to a structure containing information about a specific <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter___config.html#a77b37a46a977ee338a8407547403382e">XAudioFormatter_Config::BaseAddress</a>, <a class="el" href="struct_x_audio_formatter.html#afcb3af467d350972eaf8573bb9ec5b2f">XAudioFormatter::Config</a>, <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>, and <a class="el" href="group__audio__formatter.html#ga53384ac363365da9f8e31ed55cbf1d0b">XAudioFormatterDMAReset()</a>.</p>

<p>Referenced by <a class="el" href="xaudioformatter__selftest__example_8c.html#a64fdbf9842b52cd0c47e06996f91f736">AFSelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6bf13816fa1c5fa913e85ec5734b7dcd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatter_InterruptClear </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>mask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function clears the interrupts for audio formatter core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance. </td></tr>
    <tr><td class="paramname">offset</td><td>this is the offset to S2MM or MM2S.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="ga9c0f40a1f11f81c15f0bd0e1aea25d0a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatter_InterruptDisable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Mask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function disables the interrupts for audio formatter core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance. </td></tr>
    <tr><td class="paramname">Mask</td><td>is the interrupt mask.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="ga5779760c06dac849bd2e52ceded0ad65"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatter_InterruptEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Mask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables the interrupts for audio formatter core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance. </td></tr>
    <tr><td class="paramname">Mask</td><td>is the interrupt mask.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="ga306c87bbfa3dfceed94dec4591465bf5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_audio_formatter___config.html">XAudioFormatter_Config</a> * XAudioFormatter_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>XAudioFormatter_LookupConfig returns a reference to an <a class="el" href="struct_x_audio_formatter___config.html" title="This typedef contains configuration information for a audio formatter core. ">XAudioFormatter_Config</a> structure based on the unique device id, <em>DeviceId</em>. </p>
<p>The return value will refer to an entry in the device configuration table defined in the xaudioformatter_g.c file.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique device ID of the device for the lookup operation.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CfgPtr is a reference to a config record in the configuration table (in xaudioformatter_g.c) corresponding to <em>DeviceId</em>, or NULL if no match is found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xaudioformatter__selftest__example_8c.html#a64fdbf9842b52cd0c47e06996f91f736">AFSelfTestExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga53384ac363365da9f8e31ed55cbf1d0b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatterDMAReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function soft resets the audio formatter DMA core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="group__audio__formatter.html#gaef1d64562a996ebb195cf2d6ef2f6ea7">XAudioFormatter_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="ga65ddaecacb3d843dade3da4a44862963"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatterDMAStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function starts the dma for audio formatter core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="ga95f19d9d0e20ad8b8bafcaf277ea1ca3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatterDMAStop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function stops the dma for audio formatter core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="gabc41edf6bcea2a85b50e8893016fb267"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAudioFormatterGetDMATransferCount </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the No. </p>
<p>of bytes of data read from memory..</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Audio Formatter instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- No. of bytes of data read from memory. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="gae4e206855fe0fd0b43a40050d494b40f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatterSetFsMultiplier </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Mclk</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Fs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function calculates the Fs multiplier value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Audio Formatter instance. </td></tr>
    <tr><td class="paramname">MClk</td><td>is the frequency of the MClk. </td></tr>
    <tr><td class="paramname">Fs</td><td>is the sampling frequency of the system.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- None </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="ga0d2e42ac1ba8d83eca142032ad59320b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatterSetHwParams </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter_hw_params.html">XAudioFormatterHwParams</a> *&#160;</td>
          <td class="paramname"><em>hw_params</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the hw params for audio formatter core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter.html" title="The audio formatter driver instance data structure. ">XAudioFormatter</a> instance. </td></tr>
    <tr><td class="paramname">hw_params</td><td>is a pointer to the <a class="el" href="struct_x_audio_formatter_hw_params.html" title="This typedef contains hw params information for a audio formatter core. ">XAudioFormatterHwParams</a> structure which contains the no. of channels, bit width, no. of periods, bytes per period, bytes per channel and buffer address.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#afcb3af467d350972eaf8573bb9ec5b2f">XAudioFormatter::Config</a>, <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>, <a class="el" href="struct_x_audio_formatter___config.html#a7f7b33004190e99b88823a35bdd1ed87">XAudioFormatter_Config::MaxChannelsMM2S</a>, and <a class="el" href="struct_x_audio_formatter___config.html#a8feec23f4c0e955063ca0d6819ac3de7">XAudioFormatter_Config::MaxChannelsS2MM</a>.</p>

</div>
</div>
<a class="anchor" id="ga6d1e04ada72ed2b53ee4c03809f8146e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAudioFormatterSetS2MMTimeOut </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TimeOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the S2MM timeout. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Audio Formatter instance. </td></tr>
    <tr><td class="paramname">TimeOut</td><td>is the Timeout value after which all the data is flushed to memory if there is no incoming data from any channel.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- None </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter.html#a5894ac993866f9253b146582cbbd1887">XAudioFormatter::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="gabec553226fe4cfd97f01d23b2c30bbad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XSdiAud_GetChStat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_audio_formatter.html">XAudioFormatter</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>ChStatBuf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads all the Channel Status registers and writes to a buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Audio Formatter instance. </td></tr>
    <tr><td class="paramname">ChStatBuf</td><td>is a pointer to a buffer.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_audio_formatter___config.html#a77b37a46a977ee338a8407547403382e">XAudioFormatter_Config::BaseAddress</a>, and <a class="el" href="struct_x_audio_formatter.html#afcb3af467d350972eaf8573bb9ec5b2f">XAudioFormatter::Config</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
